shumate.Layer source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module shumate.Layer;
26 
27 private import gobject.ObjectG;
28 private import gtk.AccessibleIF;
29 private import gtk.AccessibleT;
30 private import gtk.BuildableIF;
31 private import gtk.BuildableT;
32 private import gtk.ConstraintTargetIF;
33 private import gtk.ConstraintTargetT;
34 private import gtk.Widget;
35 private import shumate.Viewport;
36 private import shumate.c.functions;
37 public  import shumate.c.types;
38 
39 
40 /**
41  * Every layer (overlay that moves together with the map) has to inherit this
42  * class and implement its virtual methods.
43  * 
44  * You can use the same layer to display many types of maps.  In Shumate they
45  * are called map sources.  You can change the [property@MapLayer:map-source]
46  * property at any time to replace the current displayed map.
47  */
48 public class Layer : Widget
49 {
50 	/** the main Gtk struct */
51 	protected ShumateLayer* shumateLayer;
52 
53 	/** Get the main Gtk struct */
54 	public ShumateLayer* getLayerStruct(bool transferOwnership = false)
55 	{
56 		if (transferOwnership)
57 			ownedRef = false;
58 		return shumateLayer;
59 	}
60 
61 	/** the main Gtk struct as a void* */
62 	protected override void* getStruct()
63 	{
64 		return cast(void*)shumateLayer;
65 	}
66 
67 	/**
68 	 * Sets our main struct and passes it to the parent class.
69 	 */
70 	public this (ShumateLayer* shumateLayer, bool ownedRef = false)
71 	{
72 		this.shumateLayer = shumateLayer;
73 		super(cast(GtkWidget*)shumateLayer, ownedRef);
74 	}
75 
76 
77 	/** */
78 	public static GType getType()
79 	{
80 		return shumate_layer_get_type();
81 	}
82 
83 	/**
84 	 * Gets the #ShumateViewport used by this layer.
85 	 *
86 	 * Returns: The #ShumateViewport.
87 	 */
88 	public Viewport getViewport()
89 	{
90 		auto __p = shumate_layer_get_viewport(shumateLayer);
91 
92 		if(__p is null)
93 		{
94 			return null;
95 		}
96 
97 		return ObjectG.getDObject!(Viewport)(cast(ShumateViewport*) __p);
98 	}
99 }